Carbon


GetThemeButtonContentBounds

Header: Appearance.h Carbon status: Supported

Obtains the rectangle where content can be drawn for a button.

OSStatus GetThemeButtonContentBounds (
    const Rect *inBounds, 
    ThemeButtonKind inKind, 
    const ThemeButtonDrawInfo *inDrawInfo, 
    Rect *outBounds
);
inBounds

A pointer to a structure of type Rect. Before calling GetThemeButtonContentBounds, set the rectangle to contain the boundary of the button, in local coordinates.

inKind

A value of type ThemeButtonKind. Pass a constant specifying the type of button being examined. See “Theme Button Kind Constants” for descriptions of possible values.

inDrawInfo

A pointer to a structure of type ThemeButtonDrawInfo. Before calling GetThemeButtonContentBounds, set the structure to contain the state, value, and adornment for the button.

outBounds

A pointer to a structure of type Rect. On return, the rectangle contains the actual boundary, in local coordinates, of the area of the button’s face in which content can be drawn.

function result

A result code.

DISCUSSION

The GetThemeButtonContentBounds function obtains the rectangle where content can be drawn for a button under the current theme.

VERSION NOTES

This function is available with Appearance Manager 1.1 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)